Lender Price API
Pricing a Loan / Common Tasks in Pricing / Dynamic Properties Map
In This Topic
    Dynamic Properties Map
    In This Topic

    The following sections describe the available dynamic properties that users can add to the dynamicPropertiesMap field.

    Customers can create dynamic properties and set basic rules for them in the Lender Price UI. Those properties will be passed to the MultiCriteriaSearchModel.dynamicPropertiesMap field like so:

    "dynamicPropertiesMap": {

      "Citizenship": {

        "fieldId": "Citizenship",

        "value": "US Citizen",

        "oValue": null,

        "init": false },

    }

     

    The list below is an example of dynamic fields created and available. For the latest list, the client can utilize the following API:

    URL: {{protocol}}{{domain}}/rest/getDynamicFields/{{companyId}}/{{userId}}

    Method: GET

    Header: 'companyId: {{companyId}}'

    Header: 'secret: {{token}}'

     

      Example Dynamic Properties Map defaulted (insert at root of search request)
    Copy Code
       "dynamicPropertiesMap": {
            "GLOBAL_GIFTFUNDPERCENT": {
                "fieldId": "GLOBAL_GIFTFUNDPERCENT",
                "value": "0"
            },
            "Citizenship": {
                "fieldId": "Citizenship",
                "value": "US Citizen"
            },
            "IncomeDocType": {
                "fieldId": "IncomeDocType",
                "value": "Full Doc - 24M"
            },
            "MORT30LATESLAST12M": {
                "fieldId": "MORT30LATESLAST12M",
                "value": "0"
            },
            "MORT60LATESLAST12M": {
                "fieldId": "MORT60LATESLAST12M",
                "value": "0"
            },
            "MORT90LATESLAST12M": {
                "fieldId": "MORT90LATESLAST12M",
                "value": "0"
            },
            "MORT120LATESLAST12M": {
                "fieldId": "MORT120LATESLAST12M",
                "value": "0"
            },
            "Global_DEEDINLIEU": {
                "fieldId": "Global_DEEDINLIEU",
                "value": "DIL_Null"
            },
            "GLOBAL_Forbearances": {
                "fieldId": "GLOBAL_Forbearances",
                "value": "ForbearNone"
            },
            "GLOBAL_RESERVES": {
                "fieldId": "GLOBAL_RESERVES",
                "value": "Reserves_12"
            },
            "GLOBAL_BorrowerType": {
                "fieldId": "GLOBAL_BorrowerType",
                "value": "Individual"
            },
            "GLOBAL_DELAYEDFINANCING": {
                "fieldId": "GLOBAL_DELAYEDFINANCING"
            },
            "GLOBAL_NoMortgageHistory": {
                "fieldId": "GLOBAL_NoMortgageHistory"
            },
            "Lateinlast12months": {
                "fieldId": "Lateinlast12months"
            },
            "Lateinlast24months": {
                "fieldId": "Lateinlast24months"
            },
            "FirstTimeInvestor": {
                "fieldId": "FirstTimeInvestor"
            },
            "GLOBAL_MixedUse": {
                "fieldId": "GLOBAL_MixedUse",
                "value": "true"
            },
            "PrepayTerm": {
                "fieldId": "PrepayTerm",
                "value": "12 Months"
            },
            "PrePayment_Plan_Type": {
                "fieldId": "PrePayment_Plan_Type"
            }
        }
    
     Global Fields
    Field Name Field Type or Enums Used Field ID Usage Path Default Value
    Unit Number PROPERTYUNIT NON-QM search.property.numberOfUnit
    Fico Number FICO NON-QM search.criteria.fico
    Property Valuation Type ACE
    PIW
    Full Appraisal
    HVE
    FMP
    Inspection
    Streamline
    1004P
    VALUATIONTYPE NON-QM search.criteria.propertyValuationType
    Exceed FHA Limit SingleLimit FHALIMITEXCEED    rateGrid.fhaMortgageLimitToMatch search.criteria.loanAmount
    Mortgage 30 lates last 12 Months NumberRange MORT30LATESLAST12M NON-QM
    Mortgage 30 lates last 24 Months NumberRange MORT30LATESLAST24M NON-QM
    Mortgage 60 lates last 12 Months NumberRange    MORT60LATESLAST12M NON-QM
    Mortgage 60 lates last 24 Months NumberRange    MORT60LATESLAST24M NON-QM
    Mortgage 90 lates last 12 Months NumberRange MORT90LATESLAST12M NON-QM
    Mortgage 90 lates last 24 Months NumberRange MORT90LATESLAST24M NON-QM
    Bankruptcy last 12 Months NumberRange BANKRUPTCYLAST12M NON-QM
    Chap.7 Bankruptcy last 12 Months NumberRange CH7BANKRUPTCYLAST12M NON-QM
    Chap.13 Bankruptcy last 12 Months NumberRange CH13BANKRUPTCYLAST12M NON-QM
    Chap.13 Bankruptcy last 24 Months NumberRange CH13BANKRUPTCYLAST24M NON-QM
    Has Open CH12 Bankruptcy Boolean OPENCH12BANKRUPCY NON-QM
    Foreclosure last 60 Months NumberRange FORECLOSURELAST60M NON-QM
    Deed in Lieu last 12 Months NumberRange FORECLOSURELAST60M NON-QM
    Deed in Lieu last 24 Months NumberRange DEEDINLIEULAST24M NON-QM
    DSCR Ratio >= 1.25
    1.00-1.24x
    0.75-0.99x
    < 0.75x
    DSCRRATIO NON-QM
    DTI > 50
    43-50
    ≤ 43
    DTI NON-QM
    Citizenship Non-Perm Resident
    Perm Resident
    US Citizen
    Foreign National
    Citizenship NON-QM
    Income Doc Type Bank Statements - 24M
    Full Doc - 24M
    DSCR
    1099 - 12M
    Full Doc - 12M
    Asset Utilization
    1099 - 24M
    Bank Statements - 12M
    IncomeDocType NON-QM
    Bankruptcy Seasoning Bank Statements - 24M
    Full Doc - 24M
    DSCR
    1099 - 12M
    Full Doc - 12M
    Asset Utilization
    1099 - 24M
    Bank Statements - 12M
    BankruptcySeasoning NON-QM
    Bankruptcy Chapter Chapter 13
    Chapter 11
    Chapter 7
    BankruptcyChapter NON-QM
    Housing History 0X30x24
    1X30X12
    0X60X12
    0X30x12
    0x90x12
    0x120x12
    HousingHistory NON-QM
    FC/SS/DIL Seasoning 7+ Years / Never
    4-7 Years
    2-4 Years
    < 2 Years
    FC/SS/DIL Seasoning NON-QM
    Prepay Term 36 Months
    24 Months
    12 Months
    None
    PrepayTerm NON-QM
    Tradelines 3 for 12+ Months
    2 for 24+ Months
    Limited
    Tradelines NON-QM
    Interest Only Boolean InterestOnly NON-QM
    Escrow Waiver Boolean EscrowWaiver NON-QM
    First Time Home Buyer Boolean FirstTimeHomeBuyer NON-QM
    FHA Case Assignment Date Date FHACASEASSIGNDATE FSB
    FHA Endorsement Date Date FHAENDORSEMENTDATE FSB  
    Affordable Housing Type None
     HFAPreferred
     HFAPreferredRiskSharing
     HomeReady
     HomePossible
    FSB None
    Application Taken Date Date Global_APPLICATIONTAKENDATE FSB search.criteria.applicationTakenDate Blank
    Execution Type Best Efforts
    Mandatory
    Global_EXECUTIONTYPE FSB search.brokerCriteria.executionType
    Doc Type Full Doc
     24 Mo. Personal Bank Statements
     12 Mo. Personal Bank Statements
     24 Mo. Business Bank Statements
     12 Mo. Business Bank Statements
     Other Bank Statements
     24 Mo. CPA Prepared P&L
     12 Mo. CPA Prepared P&L
     24 Mo. Tax-Prepared P&L
     12 Mo. Tax-Prepared P&L
     1 Yr. Tax Returns
     VOE
     Asset Utilization
     Debt Service Coverage (DSCR)
     No Ratio
    Global_DOCTYPE FSB search.criteria.docType Full Docs
    Renovation Loan Boolean Global_RENOVATIONLOAN FSB
    Cashout Amount $ Global_CASHOUTAMOUNT FSB search.criteria.cashoutAmount Blank
    Interest Only Boolean Global_INTERESTONLY FSB search.criteria.interestOnly
    First Time Home Buyer Boolean Global_FIRSTTIMEHOMEBUYER FSB search.criteria.firstTimeHomeBuyer
    Self Employed Boolean Global_SELFEMPLOYED FSB search.criteria.selfEmployed
    BuyDown 3/2/1
     2/1
     1/1
     1/0
    Global_BUYDOWN FSB search.criteria.buyDown
    Closed End Boolean Global_CLOSEDEND FSB search.criteria.closedEnd
    Balloon? Boolean Global_BALLOON FSB search.criteria.balloon
    Rural Boolean Global_RURAL FSB search.criteria.rural
    Non-Occ CoBorrower Boolean Global_NONOCCCOBWR FSB search.criteria.nonOccCoBorrower
    Prior Sale Date Date Global_PRIORSALEDATE FSB search.criteria.priorSalesDate
    Construction Draw $ Global_CONSTRUCTIONDRAW FSB search.criteria.constructionDrawAmount
    Renovation Cost $ Global_RENOVATIONCOST FSB search.criteria.renovationCost
    Borrower Count Number Global_NUMBEROFBWRS FSB search.criteria.numberOfBorrower 1
    Manufactured Initiative MH Advantage
     CHOICEHome
    Global_MHINITIATIVE FSB
    AUS Response None
     DU_Approve_Eligible
     DU_Approve_Ineligible
     DU_OutOfScope
     DU_ReferWith_Caution
     DU_ReferWith_Caution_IV
     DU_Refer_Eligible
     DU_Refer_Ineligible
     LP_Accept_Eligible
     LP_Accept_Ineligible
     LP_Caution_AMinusEligible
     LP_Caution_Eligible
     LP_Caution_Ineligible
    Global_AUSRESPONSE FSB
    Citizenship US Citizen / Permanent Resident
     Non-Permanent Resident Alien
     Non-Resident Alien
     Foreign National
    Global_CITIZENSHIP FSB
    Closing Date Date field Global_CLOSINGDATE FSB
    Community Second Boolean Global_COMMUNITYSECOND FSB
    Relocation Loan Boolean Global_RELOCATIONLOAN FSB
    VA Eligible Boolean Global_VAELIGIBLE FSB
    PrePayment Penalty Boolean Global_PREPAYMENTPENALTY FSB
    New Construction Boolean Global_NEWCONSTRUCTION FSB
    Texas 50(a)(6) Boolean Global_TX50A6 FSB
    FHA Prog Type None
    FHA 203(k)
    FHA 203(h)
    Global_FHAPROGTYPE FSB
    Foreclosures None
     >=2 Years
     >=3 Years
     >=4 Years
     >=5 Years
     >=7 Years
     Settled
    Global_FORECLOSURES FSB
    Deed in Lieu None
     >=2 Years
     >=3 Years
     >=4 Years
     >=5 Years
     Settled
    Global_DEEDINLIEU FSB
    Short Sales None
     >=2 Years
     >=3 Years
     >=4 Years
     >=5 Years
     Settled
    Global_SHORTSALES FSB
    Bankruptcies None
     BK > 4 Years
     CH 7 Discharge >=2 Yrs
     CH 7 Discharge >=3 Yrs
     CH 7 Discharge >=4 Yrs
     CH 7 Discharge >=5 Yrs
     CH 7 Discharge Settled
     CH 11 BK >=2 Yrs
     CH 11 BK >=3 Yrs
     CH 11 BK >=5 Yrs
     CH 11 Personal BK >=4 Yrs
     CH 13 BK >=2 Yrs
     CH 13 BK >=3 Yrs
     CH 13 BK >=4 Yrs
     CH 13 BK >=5 Yrs
     CH 13 BK Settled
     CH 13 Discharge >=2 Yrs
     CH 13 Dismissal >=4 Yrs
    Global_BANKRUPTCIES FSB
    # of Financed Properties Number Global_FINANCED PROPERTIES FSB
    Target Investor FNMA
     FHLMC
     FNMA and FHLMC
     Ginnie Mae
     AIG
     Flagstar
     JPMorgan Chase Bank
     The Money Source
     Mr Cooper
     Pentagon Federal CU
     Redwood
     TIAA
     Truist
     US Bank
     Wells Fargo
     Arizona Industrial Development Authority
     California Housing Finance Agency
     Golden State Finance Authority
     Connecticut Housing Finance Authority
     Colorado Housing and Finance Authority
     Idaho Housing and Finance Association
     Illinois Housing Development Authority
     Indiana Housing and Community Development Authority
     Massachusetts Housing Finance Agency
     Michigan State Housing Development Authority
     Nevada Housing Division
     Nevada Rural Housing Authority
     Ohio Housing Finance Agency
     Rhode Island Housing and Mortgage Finance Corporation
     Wisconsin Housing and Economic Development Authority
     Washington State Housing Finance Commission
    Global_TargetInvestor FSB
    FHA Purpose Type FHA to FHA
     Non-FHA to FHA
     Streamlined Refinance without Appraisal
     Streamlined Refinance with Appraisal
    Global_FHAPurposeType FSB
    Mortgage Insurance Payment Type Monthly
     Annually
     Single
    Global-MortgageInsurancePaymentType FSB search.miCriteria.paymentType
    Terms range GLOBAL_TERMS FSB search.criteria.loanYear
    Term (In Months) Boolean GLOBAL_TERMINMONTHS FSB search.termsInMonths
    Channel ForWholeSale
    ForCorresponding
    ForBroker
    AsRetail
    All
    GLOBAL_CHANNEL FSB search.brokerCriteria.rateTypes  
    Channel SubType All
    NonDelegated
    Delegated
    GLOBAL_CHANNELSUBTYPE FSB search.brokerCriteria.subRateTypes
    LPMI Eligible TRUE
    FALSE
    GLOBAL_LPMIELIGIBLE FSB
    Gift Fund % percent field GLOBAL_GIFTFUNDPERCENT Athas  
    Property is listed Boolean GLOBAL_PROPERTYLISTED Athas
    Covid Forbearance Boolean GLOBAL_COVIDFORBEARANCE Athas
    Prepay Level Level 1
    Level 2
    GLOBAL_PREPAYLEVEL Athas
    Reserves 12 Month LCRs
    6 Month LCRs
    3 Month LCRs
    No LCRs
    GLOBAL_RESERVES Athas
     Global Fields Added to Rate Grid Settings
    Field Name Field Type or Enums Used Field ID Usage Path Default Value
    ARM Qualifying Rate Calculated FSB On rate grid
    ARM Floor Rate % FSB On rate grid
    Interest Only Months Term (months) FSB On rate grid
    Investor Enum (based on id) and dynamic   FSB On rate grid
    Due Term (months) FSB On rate grid equal to term but editable
    Rounding Factor .125
     .250
     .500
    FSB On rate grid
    Amortizing Term Term (months) FSB On rate grid Freeform
     Company Level Fields
    Field Name Field Type or Official Enums Used Field ID Usage
    PremierBuilder boolean COMPANY_PremierBuilder AFR
    Adjustment Subtypes Sales
    Secondary marketing adjustor
    None
    TPO Perf Rating
    Channel adjustor
    Corporate adjustor
    ADJ_SUBTYPES FSB
    Display Flag Yes
    No
    COMPANY_DisplayFlag FSB
    Channel Subtype

    All
    NonDelegated
    Delegated Bulk
    Delegated Flow
    Distributed Retail Encompass
    Distributed Retail Loantrac
    Consumer Direct Retail

     

    COMPANY_CHANNELSUBTYPE

    FSB
    Bulk Delivery boolean (allows NULL) - default NULL and True=Bulk COMPANY_BULKDELIVERY FSB
    No VOR / VOM boolean (Null Available) COMPANY_NOVORVOM ATHAS
    Gift of Equity boolean (Null Available) COMPANY_GIFTOFEQUITY ATHAS
    DSCR Ratio No DSCR
    DSCR >1.00
    DSCR =<1.00
    COMPANY_DSCRRATIO ATHAS
    Open BK boolean (Null Available) COMPANY_OPENBK ATHAS
    Not Current boolean (Null Available) COMPANY_NOTCURRENT ATHAS
    Lease Option Buyout boolean (Null Available) COMPANY_LEASEOPTIONBUYOUT ATHAS
    51% Owner Occupied boolean (Null Available) COMPANY_51PERCENTOWNEROCC ATHAS
    Credit Grade A++
    A+
    A
    A-
    B
    B-
    C
    D
    COMPANY_CREDITGRADE ATHAS
    Bankruptcies < 4 years
    < 3 years
    < 2 years
    < 1 year
    COMPANY_BANKRUPTCIES ATHAS
    Major Mortgage Event (FC/SS/DIL) < 4 years
    < 3 years
    < 2 years
    < 1 year
    Currently In
    COMPANY_MAJOR MORTGAGEEVENT ATHAS
    SFR Used as Care Facility boolean COMPANY_SFRUSEDASCAREFACILITY ATHAS
    Major Event Settled boolean COMPANY_MAJOREVENTSETTLED ATHAS
    Lending Type Consumer Purpose
    Business Purpose
    COMPANY_LENDINGTYPE ATHAS
    Property Type SFR/PUD
    Condo
    2-4 Unit
    Townhome
    NonWarrantable Condo
    Condotel
    COMPANY_PROPTYPE ATHAS
    Property Attributes None
    Rural
    Commercial Mixed Use
    Commercial MultiFamily
    COMPANY_PROPERTYATTRIBUTES ATHAS
    Prepayment Penalty No Prepay
    1 Yr Prepay
    2 Yr Prepay
    3 Yr Prepay
    4 Yr Prepay
    5 Yr Prepay
    COMPANY_PREPAYPENALTY ATHAS
    Borrower Type Individual
    Multiple Individuals
    Trust
    LLC
    S-Corp
    C-Corp
    COMPANY_BORROWERTYPE ATHAS
    Borrower Attributes None 
    Non-Occupant Co Borrower
    First Time Home Buyer
    COMPANY_BORROWERATTRIBUTES ATHAS
    ITIN with Visa Boolean COMPANY_ITIN ATHAS
    ACH Boolean COMPANY_ACH ATHAS
    Income Doc Type Full Document
    Alt - 12 mo bank stmts
    Lite - 6 mo bank stmts
    NINA - No Income, No Assets
    NISA - No Income, Stated Assets
    No Doc (NINANE) - No Income, No Assets, No Employ
    No Ratio (NIVA) - No Income, Verified Assets
    NIV (SISA) - Stated Income, Stated Assets
    NIV (SIVA) - Stated Income, Verified Assets
    VISA - Verified Income, Stated Assets
    No Doc Verif Assets - No Inc, Verified Assets No Employ
    VINA - Verified Income, No Assets
    Alt Doc – 24
    Alt Doc – 12
    Alt Doc – VOE
    Alt Doc – P&L
    Alt Doc – K-1
    Alt Doc – 1099
    Alt Doc – AD-5 year
    Re-Entry to Workforce
    Contract w/in 60 days
    12 month Full doc
    12 month 1099
    12 Month K-1
    COMPANY_INCOMEDOCTYPE ATHAS
    Channel Refinance
    New Construction
    Company Generated
    Discount Tier 1
    Employee Loan
    Family Loan
    COMPANY_CXSD_CHANNEL   Veritas